home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 8 / The Arsenal Files Collection #8 (Arsenal Computer) (1996).ISO / doorware / check20.zip / README.TXT < prev    next >
Text File  |  1996-11-15  |  13KB  |  270 lines
  1.                     Documentation for BBS Checkers Door Game
  2.                          Written by Robert V. Chambers
  3.                                Copyright (c) 1996
  4.  
  5.  
  6. WHAT IS BBS CHECKERS?
  7. BBS  Checkers  allows users to play a  standard  game of checkers against each
  8. other.  Players  can start and join games,  send messages in a game, and learn
  9. how  the  game  is  played. There  is  no  maintenance;  everything is handled
  10. automatically.  The  game  generates a scores  bulletin  in both ansi and text
  11. format  as  well  as  a who-beat-who  bulletin.  Setup  is simple and straight
  12. forward.
  13.  
  14. SYSTEM REQUIREMENTS:
  15. 386 or better processor
  16. Requires ANSI graphics on the user's end
  17. ~170K memory
  18.  
  19. WHAT ARE SOME OF THE FEATURES?
  20. *  Up to 200 simultaneous games.
  21. *  Optional activity log.
  22. *  Has a sysop chat mode.
  23. *  Fossil aware.
  24. *  No maintenance required.
  25. *  Supports   standard   drop  files   such   as  DOOR.SYS  (PCBoard/GAP),
  26.    DORINFO1.DEF, EXITINFO.BBS, CHAIN.TXT, etc.
  27. *  Runs on multiple nodes (one player only).
  28. *  Sysop configurable path\filename for scores bulletin.
  29. *  In-game messaging for players
  30.  
  31. LIMITATIONS ON UNREGISTERED VERSION:
  32. The  unregistered version will only allow a single  user to be involved in two
  33. games  simultaneously.  You  must  register  the  program  to  eliminate  this
  34. restriction. See the section on registration below.
  35.  
  36. UPGRADING FROM A PREVIOUS VERSION:
  37. Unzip  all  files  in the archive over  your  existing  door files. If you are
  38. upgrading  from V1.1 then on line 5  of CHECKERS.CFG add the complete path and
  39. file  name  (without the extension) for the  scores bulletin you would like to
  40. create.  See SAMPLE.CFG for more details  and example. Upgrading from versions
  41. later than V1.1 do not require any modifications. That's it!
  42.  
  43. HOW DO I INSTALL IT:
  44. This is simple, but you must follow these instructions. I am assuming that you
  45. are already familiar with the steps required to install a door on your BBS. If
  46. not,  I  would  suggest  that you read  your  manual  first. This doc will not
  47. attempt to guide you through that.
  48.  
  49. Step  1)
  50.         Unzip all files into a single directory of your choice.
  51.  
  52. Step  2)
  53.         Create  a batch file that your BBS  will use to start the door. I use
  54.         PCBoard, and my file looks something like this:
  55.  
  56.         @echo off
  57.         cd\pcb\checkers
  58.         checkers.exe c:\pcb\node1\door.sys /L
  59.         IF "%INPCB"=="Y" EXIT
  60.         %PCBDRIVE%
  61.         %PCBDIR%
  62.         board
  63.  
  64.         You  may call the file whatever you like, subject to restrictions that
  65.         may  be enforced by your BBS software. Mine is simply called CHECKERS,
  66.         with no .BAT extension. Again, consult your manual.
  67.  
  68.         A  little explanation of the startup batch  file is in order here. The
  69.         first  line simply changes to the directory where all of your Checkers
  70.         program  files are found. (Remember you put them there in Step 1.) The
  71.         second line is the name of the door program, CHECKERS.EXE, followed by
  72.         the  complete  path  to  your drop  file  and  the (optional) log file
  73.         switch.  Notice that the drop file name is specified. If you are using
  74.         PCBoard,  you  may also use the  PCBoard environment variables for the
  75.         path to the drop file, like this:
  76.  
  77.                         checkers.exe %PCBDRIVE%%PCBDIR%\door.sys
  78.  
  79.         If you wish the program to log its activities, add "/L" after the path
  80.         to  the  drop  file, like this:
  81.  
  82.                       checkers.exe %PCBDRIVE%%PCBDIR%\door.sys /L
  83.  
  84.         The program will create CHECKERS.LOG which will contain information on
  85.         door usage.  See the section below on "LOGGING ACTIVITY".
  86.  
  87.         Finally,   use   whatever  door   exiting   statements  your  software
  88.         recommends. Your startup file will undoubtedly look different, but you
  89.         get the general idea.
  90.  
  91. Step  3)
  92.         Setup  your BBS software and configure  any door menus, etc. that give
  93.         the user access.
  94.  
  95. Step  4)
  96.         Edit  the sample configuration file to suit your tastes and save it as
  97.         CHECKERS.CFG.  Instructions for each line  are contained in the sample
  98.         file, SAMPLE.CFG.
  99.  
  100. Step  5)
  101.         You're finished! That wasn't so bad after all.
  102.  
  103. PS-> Don't forget to advertise that you now have a new door on your system!
  104.  
  105. RUNNING LOCAL:
  106. You can run the game in local mode if a drop file is in the program directory.
  107. DORINFO1.DEF is included in the archive for this purpose. Just place it in the
  108. door  program file directory and execute  the program by running CHECKERS.EXE.
  109. You  should be able to leave this file  in your game directory with no problem
  110. since  you  have defined the path to the  real drop file in your startup batch
  111. file. This is offered only for the purposes of demonstrating the game prior to
  112. installation.
  113.  
  114. CUSTOMIZATION:
  115.  
  116. - TITLE SCREEN
  117. If  you want a new title screen you can  do it. Create a new screen using your
  118. favorite  ANSI editor, and call it TITLE.ANS.  Leave enough room at the bottom
  119. for  the additional registration text. It's *CRITICAL* that you name this file
  120. correctly.
  121.  
  122. - INACTIVITY TIMEOUT AND MAXIMUM DOOR TIME
  123. You  may specify the maximum time allowed in the door and the keyboard timeout
  124. limit  by  editing DOOR.CFG. Instructions are in  this file and should be self
  125. explanatory.  Be  sure that you leave your  users enough time to think about a
  126. move!
  127.  
  128. - LOGGING ACTIVITY
  129. The program will provide logging of activity if the logging switch is included
  130. in the startup command line in your batch file. For example:
  131.  
  132.                      checkers.exe c:\pcb\node1\door.sys /L
  133.  
  134. will cause the program to record entry/exit times and game deletions in a file
  135. called  CHECKERS.LOG.  This  file  can  become  lengthy  if  the  door is used
  136. regularly.  A  suggestion  is  to enable  logging  when  the door is initially
  137. installed  to monitor its use or when  you add something special that you want
  138. your users to view or download. After a period of time you may wish to disable
  139. logging or trim the file occasionally (there are programs that will do this in
  140. an event). Please note that the switch (/L) is case specific and there must be
  141. a space between it and the path to the drop file.
  142.  
  143. MAINTENANCE:
  144. There  is no maintenance! The game will run its own maintenance when the first
  145. player  of  the day enters the game.  In  addition to deleting games that have
  146. expired  due to lack of play both  GAMES.DAT and WINNERS.DAT will be backed up
  147. in  the  game  directory.  The  backup  files  will  be  named  GAMES.BAK  and
  148. WINNERS.BAK.  Hopefully  you will never need  this, but occasionally things do
  149. happen.
  150.  
  151. MULTINODE USE:
  152. The  game is set up to run on multiple nodes, but at this time only one player
  153. may  be  in  the  game at a time. If  for  some  reason the door does not exit
  154. properly (power failure, etc.) you will need to delete the file INUSE.DAT from
  155. the  Checkers directory. The presence of this  tiny file signals the game that
  156. another  player is currently playing and prevents others from entering. I have
  157. an entry in my nightly event that attempts to delete this file just in case it
  158. happens to exist.
  159.  
  160. HOW TO RESET THE GAME:
  161. You  should never need to reset the game, but in case you want to a batch file
  162. is  included  (RESET.BAT)  that will delete  all  files necessary to reset the
  163. game.  "News"  files  will be deleted,  but  bulletins  will not. Backup files
  164. (GAMES.BAK and WINNERS.BAK) will not be deleted.
  165.  
  166. TROUBLE  SHOOTING:
  167. In  the  event you have trouble maybe some  of  these tips will help you. This
  168. list  is  not  very  long yet, but  will  be  added  to as information becomes
  169. available.
  170.  
  171. 1)  The  door  will not open at all.  It  looks like it tries, but immediately
  172. shuts down and returns to the BBS.
  173.  
  174. -  This is almost certainly a sign that the startup file is not specifying the
  175. correct  path  and/or file name of the  drop file. It's also possible that you
  176. have  not  set the board up correctly and  the expected drop file is not being
  177. created.  The  startup batch file must include  the full path and file name of
  178. the  drop file as an argument to  the executable, CHECKERS.EXE. See the sample
  179. startup file above.
  180.  
  181. 2)  You  are using DOOR.SYS and the  door  keeps logging you out when entering
  182. locally.
  183.  
  184. - If you are not using the long GAP version (51 lines) of DOOR.SYS then either
  185. go  to  the long version or try  DORINFO1.DEF. The DORINFO style drop file has
  186. been successfully tested on Maximus.
  187.  
  188. 3)  The graphics don't behave exactly right (on the user's end) with the board
  189. running under Windows 95.
  190.  
  191. -  If  you  experience problems with this  try  running the window either full
  192. screen  or  in  the  foreground. This seems  to  solve  the problem if you are
  193. running  the  X00 fossil driver, but is  not feasible if running more than one
  194. node. Try switching to the BNU fossil driver. This driver seems to work better
  195. with  Win95,  and  cleared up the graphics  problem  for  me (I was previously
  196. running X00).
  197.  
  198.  
  199. THE LEGAL STUFF:
  200. Users  of BBS Checkers Door Game must accept this disclaimer of warranty: "BBS
  201. Checkers  Door  Game is supplied as  is.  The author disclaims all warranties,
  202. expressed  or  implied,  including,  without  limitation,  the  warranties  of
  203. merchantability  and  of  fitness  for  any  purpose.  The  author  assumes no
  204. liability  for damages, direct or consequential, which may result from the use
  205. of BBS Checkers Door Game."
  206.  
  207. By  registering  you do NOT own this  software.  You have simply licensed it's
  208. use.  You may use it on as many BBS  nodes as you wish, as long as these nodes
  209. comprise  a single bulletin board system. You  may create as many instances of
  210. the program as you wish, as long as they all reside on a single bulletin board
  211. system.
  212.  
  213. You  are  encouraged to pass a copy of  BBS Checkers along to your friends for
  214. evaluation.  Please  encourage them to register  their  copy if they find that
  215. they  can use it. You may **NOT**  pass along your registration code, however.
  216. This should go without saying.
  217.  
  218. REGISTRATION :
  219. This  is  not  freeware; it is shareware.  If  you  are not familiar with this
  220. concept it means that you are allowed to try the software free of charge for a
  221. period  of time not to exceed 30 days. At the end of this time you must either
  222. register it or remove it from your system.
  223.  
  224. I  feel  that  the  time  invested in  writing  and  testing  the  program was
  225. significant  enough  to justify a registration fee.  The cost is $15 U.S., and
  226. payment  may be made via check drawn on  a United States bank. No credit cards
  227. are accepted. I will take your cash, but you send it at your own risk.
  228.  
  229. To  register  fill  out REGISTER.FRM (included)  and  send it, along with your
  230. check  or money order, to the address on  the form. I will respond to you with
  231. your  registration  either  through U.S.  Postal  Service, Fidonet Netmail, or
  232. Internet E-Mail. The choice is yours; just be sure to specify which you prefer
  233. on the form.
  234.  
  235. When  you receive your registration code manually edit CHECKERS.CFG and change
  236. the first two lines to your registered name and code number. The first line is
  237. case  and space specific. Watch out for  spaces at the end of the registration
  238. name.
  239.  
  240. The  unregistered  version will only support  two simultaneous games per user.
  241. Registration  will  remove  this limitation and allow  the  user to join up to
  242. twenty games. Registration will also entitle you to free lifetime upgrades.
  243.  
  244. There  will  be no automatic notification of  upgrades. You can always get the
  245. latest  version  from my BBS, Tequilla  Sunrise,  at (504)-756-0383. Just type
  246. FREE  at  the  main  menu prompt. There  is  no  charge  (except LD charges if
  247. applicable) for the file or to become a member of the BBS.
  248.  
  249.  
  250. TECHNICAL SUPPORT:
  251. Technical support will be provided to both registered and non-registered users
  252. to  the  best  of my ability.
  253.  
  254. You may reach me via the following:
  255.  
  256. Fidonet -              Robert Chambers@1:3800/49
  257. Internet EMail -       chambers@premier.net
  258. Tequilla Sunrise BBS - (504)-756-0383
  259.  
  260.  
  261. MANY THANKS!:
  262. Thanks  to all of the users that put up with the frustration of playing a game
  263. during  the testing phase and made many  helpful suggestions along the way. In
  264. particular  thanks to John Noble, who played me to the first win (I think John
  265. won  this  one),  and  to Bernie Ballard  who  helped  me test the program and
  266. continually challenged me to add new and necessary functionality to the game.
  267.  
  268. Thanks to all you guys!  I owe you one!
  269.  
  270.